
<!DOCTYPE HTML>
<html lang="" >
    <head>
        <meta charset="UTF-8">
        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
        <title>文档模块 · GitBook</title>
        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
        <meta name="description" content="">
        <meta name="generator" content="GitBook 3.2.3">
        
        
        
    
    <link rel="stylesheet" href="../../gitbook/style.css">

    
            
                
                <link rel="stylesheet" href="../../gitbook/gitbook-plugin-highlight/website.css">
                
            
                
                <link rel="stylesheet" href="../../gitbook/gitbook-plugin-search/search.css">
                
            
                
                <link rel="stylesheet" href="../../gitbook/gitbook-plugin-fontsettings/website.css">
                
            
        

    

    
        
    
        
    
        
    
        
    
        
    
        
    

        
    
    
    <meta name="HandheldFriendly" content="true"/>
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black">
    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="../../gitbook/images/apple-touch-icon-precomposed-152.png">
    <link rel="shortcut icon" href="../../gitbook/images/favicon.ico" type="image/x-icon">

    
    <link rel="next" href="testing.html" />
    
    
    <link rel="prev" href="sigils.html" />
    

    </head>
    <body>
        
<div class="book">
    <div class="book-summary">
        
            
<div id="book-search-input" role="search">
    <input type="text" placeholder="Type to search" />
</div>

            
                <nav role="navigation">
                


<ul class="summary">
    
    

    

    
        
        <li class="header">第一部分：基础</li>
        
        
    
        <li class="chapter " data-level="1.1" data-path="../../">
            
                <a href="../../">
            
                    
                    Introduction
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.2" data-path="basics.html">
            
                <a href="basics.html">
            
                    
                    基础
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.3" data-path="collections.html">
            
                <a href="collections.html">
            
                    
                    集合
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.4" data-path="enum.html">
            
                <a href="enum.html">
            
                    
                    Enum 模块
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.5" data-path="pattern-matching.html">
            
                <a href="pattern-matching.html">
            
                    
                    模式匹配
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.6" data-path="control-structures.html">
            
                <a href="control-structures.html">
            
                    
                    控制语句
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.7" data-path="functions.html">
            
                <a href="functions.html">
            
                    
                    函数
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.8" data-path="pipe-operator.html">
            
                <a href="pipe-operator.html">
            
                    
                    管道操作符
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.9" data-path="modules.html">
            
                <a href="modules.html">
            
                    
                    模块(Module)
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.10" data-path="mix.html">
            
                <a href="mix.html">
            
                    
                    Mix
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.11" data-path="sigils.html">
            
                <a href="sigils.html">
            
                    
                    魔符(Sigil)
            
                </a>
            

            
        </li>
    
        <li class="chapter active" data-level="1.12" data-path="documentation.html">
            
                <a href="documentation.html">
            
                    
                    文档模块
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.13" data-path="testing.html">
            
                <a href="testing.html">
            
                    
                    测试
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.14" data-path="comprehensions.html">
            
                <a href="comprehensions.html">
            
                    
                    推导
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.15" data-path="strings.html">
            
                <a href="strings.html">
            
                    
                    字符串
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.16" data-path="date-time.html">
            
                <a href="date-time.html">
            
                    
                    日期和时间
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.17" data-path="mix-tasks.html">
            
                <a href="mix-tasks.html">
            
                    
                    自定义Mix任务
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.18" data-path="iex-helpers.html">
            
                <a href="iex-helpers.html">
            
                    
                    IEx辅助函数
            
                </a>
            

            
        </li>
    

    
        
        <li class="header">第二部分：高级</li>
        
        
    
        <li class="chapter " data-level="2.1" data-path="../advanced/erlang.html">
            
                <a href="../advanced/erlang.html">
            
                    
                    和Erlang互操作
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.2" data-path="../advanced/error-handling.html">
            
                <a href="../advanced/error-handling.html">
            
                    
                    错误处理
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.3" data-path="../advanced/escripts.html">
            
                <a href="../advanced/escripts.html">
            
                    
                    可执行文件
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.4" data-path="../advanced/concurrency.html">
            
                <a href="../advanced/concurrency.html">
            
                    
                    并发
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.5" data-path="../advanced/otp-concurrency.html">
            
                <a href="../advanced/otp-concurrency.html">
            
                    
                    OTP并发
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.6" data-path="../advanced/otp-supervisors.html">
            
                <a href="../advanced/otp-supervisors.html">
            
                    
                    OTP Supervisors
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.7" data-path="../advanced/otp-distribution.html">
            
                <a href="../advanced/otp-distribution.html">
            
                    
                    OTP 分布式
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.8" data-path="../advanced/metaprogramming.html">
            
                <a href="../advanced/metaprogramming.html">
            
                    
                    元编程
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.9" data-path="../advanced/umbrella-projects.html">
            
                <a href="../advanced/umbrella-projects.html">
            
                    
                    Umbrella Projects
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.10" data-path="../advanced/typespec.html">
            
                <a href="../advanced/typespec.html">
            
                    
                    Specifications and types
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.11" data-path="../advanced/behaviours.html">
            
                <a href="../advanced/behaviours.html">
            
                    
                    行为
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.12" data-path="../advanced/gen-stage.html">
            
                <a href="../advanced/gen-stage.html">
            
                    
                    GenStage
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.13" data-path="../advanced/protocols.html">
            
                <a href="../advanced/protocols.html">
            
                    
                    协议
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.14" data-path="../advanced/nerves.html">
            
                <a href="../advanced/nerves.html">
            
                    
                    Nerves
            
                </a>
            

            
        </li>
    

    
        
        <li class="header">第三部分：ECTO</li>
        
        
    
        <li class="chapter " data-level="3.1" data-path="../ecto/basics.html">
            
                <a href="../ecto/basics.html">
            
                    
                    Basics
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="3.2" data-path="../ecto/changesets.html">
            
                <a href="../ecto/changesets.html">
            
                    
                    Changesets
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="3.3" data-path="../ecto/associations.html">
            
                <a href="../ecto/associations.html">
            
                    
                    关联关系
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="3.4" data-path="../ecto/querying.html">
            
                <a href="../ecto/querying.html">
            
                    
                    查询
            
                </a>
            

            
        </li>
    

    
        
        <li class="header">第四部分：专题</li>
        
        
    
        <li class="chapter " data-level="4.1" data-path="../specifics/plug.html">
            
                <a href="../specifics/plug.html">
            
                    
                    Plug
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="4.2" data-path="../specifics/eex.html">
            
                <a href="../specifics/eex.html">
            
                    
                    嵌入的 Elixir(EEx)
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="4.3" data-path="../specifics/ets.html">
            
                <a href="../specifics/ets.html">
            
                    
                    Erlang 项式存储(ETS)
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="4.4" data-path="../specifics/mnesia.html">
            
                <a href="../specifics/mnesia.html">
            
                    
                    Mnesia 数据库
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="4.5" data-path="../specifics/debugging.html">
            
                <a href="../specifics/debugging.html">
            
                    
                    调试
            
                </a>
            

            
        </li>
    

    
        
        <li class="header">第五部分：程序库</li>
        
        
    
        <li class="chapter " data-level="5.1" data-path="../libraries/guardian.html">
            
                <a href="../libraries/guardian.html">
            
                    
                    Guardian(基础)
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="5.2" data-path="../libraries/poolboy.html">
            
                <a href="../libraries/poolboy.html">
            
                    
                    Poolboy
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="5.3" data-path="../libraries/benchee.html">
            
                <a href="../libraries/benchee.html">
            
                    
                    Benchee
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="5.4" data-path="../libraries/bypass.html">
            
                <a href="../libraries/bypass.html">
            
                    
                    Bypass
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="5.5" data-path="../libraries/distillery.html">
            
                <a href="../libraries/distillery.html">
            
                    
                    Distillery(基础)
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="5.6" data-path="../libraries/stream-data.html">
            
                <a href="../libraries/stream-data.html">
            
                    
                    StreamData
            
                </a>
            

            
        </li>
    

    

    <li class="divider"></li>

    <li>
        <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
            Published with GitBook
        </a>
    </li>
</ul>


                </nav>
            
        
    </div>

    <div class="book-body">
        
            <div class="body-inner">
                
                    

<div class="book-header" role="navigation">
    

    <!-- Title -->
    <h1>
        <i class="fa fa-circle-o-notch fa-spin"></i>
        <a href="../.." >文档模块</a>
    </h1>
</div>




                    <div class="page-wrapper" tabindex="-1" role="main">
                        <div class="page-inner">
                            
<div id="book-search-results">
    <div class="search-noresults">
    
                                <section class="normal markdown-section">
                                
                                <p>Documenting Elixir code.</p>
<h2 id="&#x6CE8;&#x89E3;">&#x6CE8;&#x89E3;</h2>
<p>&#x5982;&#x4F55;&#x5199;&#x6CE8;&#x91CA;&#x4EE5;&#x53CA;&#x5982;&#x4F55;&#x7F16;&#x5199;&#x9AD8;&#x8D28;&#x91CF;&#x7684;&#x6587;&#x6863;&#xFF0C;&#x8FD9;&#x4E24;&#x4E2A;&#x95EE;&#x9898;&#x5728;&#x7F16;&#x7A0B;&#x754C;&#x4F9D;&#x7136;&#x5B58;&#x5728;&#x5F88;&#x591A;&#x4E89;&#x8BBA;&#x3002;&#x7136;&#x800C;&#xFF0C;&#x5728;&#x4EE3;&#x7801;&#x4E2D;&#x52A0;&#x5165;&#x9002;&#x5F53;&#x7684;&#x6587;&#x6863;&#x6216;&#x8005;&#x6CE8;&#x91CA;&#x5F88;&#x91CD;&#x8981;&#xFF0C;&#x8FD9;&#x70B9;&#x662F;&#x6CA1;&#x6709;&#x4EC0;&#x4E48;&#x4E89;&#x8BAE;&#x7684;&#x3002;</p>
<p>Elixir&#x628A;&#x6587;&#x6863;&#x770B;&#x4F5C;&#x662F;<em>&#x4E00;&#x7B49;&#x516C;&#x6C11;</em>&#xFF0C;&#x5B83;&#x63D0;&#x4F9B;&#x4E86;&#x5927;&#x91CF;&#x7684;&#x51FD;&#x6570;&#x6765;&#x4E3A;&#x9879;&#x76EE;&#x521B;&#x5EFA;&#x548C;&#x64CD;&#x4F5C;&#xFF08;access&#xFF09;&#x6587;&#x6863;&#x3002;Elixir&#x63D0;&#x4F9B;&#x4E86;&#x591A;&#x79CD;&#x65B9;&#x5F0F;&#x6765;&#x7F16;&#x5199;&#x6CE8;&#x91CA;&#x6216;&#x8005;&#x662F;&#x6CE8;&#x89E3;&#x3002;&#x4E0B;&#x9762;&#x662F;&#x5176;&#x4E2D;&#x4E09;&#x79CD;&#x65B9;&#x5F0F;&#xFF1A;</p>
<ul>
<li><code>#</code> - &#x7528;&#x4E8E;&#x5355;&#x884C;&#x7684;&#x6CE8;&#x91CA;</li>
<li><code>@moduledoc</code> - &#x7528;&#x4E8E;&#x6A21;&#x5757;&#x6587;&#x6863;&#x7684;&#x6CE8;&#x91CA;</li>
<li><code>@doc</code> - &#x7528;&#x4E8E;&#x51FD;&#x6570;&#x7684;&#x6CE8;&#x91CA;</li>
</ul>
<h3 id="&#x5355;&#x884C;&#x6CE8;&#x91CA;">&#x5355;&#x884C;&#x6CE8;&#x91CA;</h3>
<p>&#x6700;&#x7B80;&#x5355;&#x7684;&#x6CE8;&#x91CA;&#x4EE3;&#x7801;&#x7684;&#x65B9;&#x5F0F;&#x53EF;&#x80FD;&#x662F;&#x4F7F;&#x7528;&#x5355;&#x884C;&#x6CE8;&#x91CA;&#x4E86;&#x3002;&#x4E0E;Ruby&#x6216;Python&#x7C7B;&#x4F3C;&#xFF0C;Elixir&#x7684;&#x5355;&#x884C;&#x6CE8;&#x91CA;&#x6807;&#x8BC6;&#x7B26;&#x4E3A;<code>#</code>&#xFF0C;&#x4E5F;&#x5C31;&#x662F;&#x4E95;&#x53F7;&#x3002;</p>
<p>&#x770B;&#x4E0B;&#x8FD9;&#x4E2A;Elixir Script (greeting.exs)&#xFF1A;</p>
<pre><code class="lang-elixir"><span class="hljs-comment"># Outputs &apos;Hello, chum.&apos; to the console.</span>
IO.puts(<span class="hljs-string">&quot;Hello, &quot;</span> &lt;&gt; <span class="hljs-string">&quot;chum.&quot;</span>)
</code></pre>
<p>&#x5BF9;&#x4E8E;&#x6BCF;&#x4E00;&#x884C;&#xFF0C;Elixir&#x4F1A;&#x5FFD;&#x7565;<code>#</code>&#x5230;&#x884C;&#x672B;&#x7684;&#x6240;&#x6709;&#x5185;&#x5BB9;&#x3002;&#x8FD9;&#x79CD;&#x6CE8;&#x91CA;&#x4E0D;&#x4F1A;&#x5F71;&#x54CD;&#x5230;&#x7A0B;&#x5E8F;&#x7684;&#x6267;&#x884C;&#xFF0C;&#x4F46;&#x662F;&#x522B;&#x4EBA;&#x5728;&#x9605;&#x8BFB;&#x4EE3;&#x7801;&#x65F6;&#x5B83;&#x53EF;&#x80FD;&#x4E0D;&#x4F1A;&#x5F88;&#x5BB9;&#x6613;&#x5730;&#x88AB;&#x770B;&#x5230;&#x3002;&#x56E0;&#x6B64;&#x4E0D;&#x8981;&#x6EE5;&#x7528;&#x5355;&#x884C;&#x6CE8;&#x91CA;&#x3002;&#x4E71;&#x7528;&#x6CE8;&#x91CA;&#x53EF;&#x80FD;&#x6210;&#x4E3A;&#x522B;&#x4EBA;&#x7684;&#x5669;&#x68A6;&#x3002;&#x9002;&#x5EA6;&#x4F7F;&#x7528;&#x5C31;&#x5F88;&#x597D;&#x3002;</p>
<h3 id="&#x6A21;&#x5757;&#x6CE8;&#x91CA;">&#x6A21;&#x5757;&#x6CE8;&#x91CA;</h3>
<p><code>@moduledoc</code>&#x63D0;&#x4F9B;&#x6A21;&#x5757;&#x7EA7;&#x522B;&#x7684;&#x6CE8;&#x91CA;&#x3002;&#x8FD9;&#x4E2A;&#x6CE8;&#x89E3;&#x4E00;&#x822C;&#x653E;&#x5728;&#x6A21;&#x5757;&#x5B9A;&#x4E49;&#x7684;&#x6700;&#x524D;&#x9762;&#xFF0C;&#x4E5F;&#x5C31;&#x662F;<code>defmodule</code>&#x540E;&#x3002;&#x4E0B;&#x9762;&#x7684;&#x4F8B;&#x5B50;&#x7B80;&#x5355;&#x5730;&#x5C55;&#x793A;&#x4E86;<code>@moduledoc</code>&#x8FD9;&#x4E2A;&#x88C5;&#x9970;&#x5668;&#x7684;&#x7528;&#x6CD5;&#x3002;</p>
<pre><code class="lang-elixir"><span class="hljs-class"><span class="hljs-keyword">defmodule</span> <span class="hljs-title">Greeter</span></span> <span class="hljs-keyword">do</span>
  <span class="hljs-variable">@moduledoc</span> <span class="hljs-string">&quot;&quot;</span><span class="hljs-string">&quot;
  Provides a function `hello/1` to greet a human
  &quot;</span><span class="hljs-string">&quot;&quot;</span>

  <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">hello</span></span>(name) <span class="hljs-keyword">do</span>
    <span class="hljs-string">&quot;Hello, &quot;</span> &lt;&gt; name
  <span class="hljs-keyword">end</span>
<span class="hljs-keyword">end</span>
</code></pre>
<p>&#x7528;&#x6237;&#x53EF;&#x4EE5;&#x5728;IEx&#x91CC;&#x9762;&#x901A;&#x8FC7;<code>h</code>&#x8FD9;&#x4E2A;&#x8F85;&#x52A9;&#x51FD;&#x6570;&#x770B;&#x5230;&#x6211;&#x4EEC;&#x5728;&#x8FD9;&#x4E2A;&#x6A21;&#x5757;&#x91CC;&#x5B9A;&#x4E49;&#x7684;&#x6587;&#x6863;&#x3002;</p>
<pre><code class="lang-elixir">iex&gt; c(<span class="hljs-string">&quot;greeter.ex&quot;</span>)
[Greeter]

iex&gt; h Greeter

                Greeter

Provides a function hello/<span class="hljs-number">1</span> to greet a human
</code></pre>
<h3 id="&#x51FD;&#x6570;&#x6CE8;&#x91CA;">&#x51FD;&#x6570;&#x6CE8;&#x91CA;</h3>
<p>&#x6B63;&#x5982;Elixir&#x63D0;&#x4F9B;&#x7684;&#x6A21;&#x5757;&#x7EA7;&#x522B;&#x7684;&#x6CE8;&#x91CA;&#xFF0C;&#x5B83;&#x4E5F;&#x4E3A;&#x51FD;&#x6570;&#x7EA7;&#x522B;&#x7684;&#x6CE8;&#x91CA;&#x63D0;&#x4F9B;&#x4E86;&#x6CE8;&#x91CA;&#x529F;&#x80FD;&#x3002;<code>@doc</code>&#x8FD9;&#x4E2A;&#x88C5;&#x9970;&#x5668;&#x80FD;&#x591F;&#x63D0;&#x4F9B;&#x51FD;&#x6570;&#x7EA7;&#x522B;&#x7684;&#x6587;&#x6863;&#x6CE8;&#x91CA;&#x3002;<code>@doc</code>&#x88C5;&#x9970;&#x5668;&#x4F7F;&#x7528;&#x7684;&#x65F6;&#x5019;&#x53EA;&#x9700;&#x8981;&#x653E;&#x5728;&#x51FD;&#x6570;&#x5B9A;&#x4E49;&#x524D;&#x3002;</p>
<pre><code class="lang-elixir"><span class="hljs-class"><span class="hljs-keyword">defmodule</span> <span class="hljs-title">Greeter</span></span> <span class="hljs-keyword">do</span>
  <span class="hljs-variable">@moduledoc</span> <span class="hljs-string">&quot;&quot;</span><span class="hljs-string">&quot;
  ...
  &quot;</span><span class="hljs-string">&quot;&quot;</span>

  <span class="hljs-variable">@doc</span> <span class="hljs-string">&quot;&quot;</span><span class="hljs-string">&quot;
  Prints a hello message

  ## Parameters

    - name: String that represents the name of the person.

  ## Examples

      iex&gt; Greeter.hello(&quot;</span>Sean<span class="hljs-string">&quot;)
      &quot;</span>Hello, Sean<span class="hljs-string">&quot;

      iex&gt; Greeter.hello(&quot;</span>pete<span class="hljs-string">&quot;)
      &quot;</span>Hello, pete<span class="hljs-string">&quot;

  &quot;</span><span class="hljs-string">&quot;&quot;</span>
  <span class="hljs-variable">@spec</span> hello(String.t()) <span class="hljs-symbol">:</span><span class="hljs-symbol">:</span> String.t()
  <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">hello</span></span>(name) <span class="hljs-keyword">do</span>
    <span class="hljs-string">&quot;Hello, &quot;</span> &lt;&gt; name
  <span class="hljs-keyword">end</span>
<span class="hljs-keyword">end</span>
</code></pre>
<p>&#x5982;&#x679C;&#x5728;IEx&#x4E2D;&#x8F93;&#x5165;&#x8FD9;&#x4E2A;&#x51FD;&#x6570;&#x5E76;&#x4E14;&#x5E26;&#x6709;<code>-h</code>&#x53C2;&#x6570;&#x65F6;&#xFF08;&#x522B;&#x5FD8;&#x4E86;&#x8F93;&#x5165;&#x6A21;&#x5757;&#x540D;&#xFF09;&#xFF0C;&#x4F60;&#x5C06;&#x4F1A;&#x770B;&#x5230;&#x4E0B;&#x5217;&#x7ED3;&#x679C;&#xFF1A;</p>
<pre><code class="lang-elixir">iex&gt; c(<span class="hljs-string">&quot;greeter.ex&quot;</span>)
[Greeter]

iex&gt; h Greeter.hello

                <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">hello</span></span>(name)

Prints a hello message

Parameters

  &#x2022; <span class="hljs-symbol">name:</span> String that represents the name of the person.

Examples

    iex&gt; Greeter.hello(<span class="hljs-string">&quot;Sean&quot;</span>)
    <span class="hljs-string">&quot;Hello, Sean&quot;</span>

    iex&gt; Greeter.hello(<span class="hljs-string">&quot;pete&quot;</span>)
    <span class="hljs-string">&quot;Hello, pete&quot;</span>

iex&gt;
</code></pre>
<p>&#x6CE8;&#x610F;&#x5230;&#x6211;&#x4EEC;&#x662F;&#x5982;&#x4F55;&#x4F7F;&#x7528;&#x6587;&#x6863;&#x6807;&#x8BB0;&#x4EE5;&#x53CA;&#x7EC8;&#x7AEF;&#x662F;&#x600E;&#x4E48;&#x6E32;&#x67D3;&#x8FD9;&#x4E9B;&#x6587;&#x6863;&#x7684;&#x4E86;&#x4E48;&#xFF1F;&#x8FD9;&#x5F88;&#x4E0D;&#x9519;&#x5427;&#xFF0C;&#x5F53;&#x4F60;&#x770B;&#x5230;&#x4F7F;&#x7528;ExDoc&#x6A21;&#x5757;&#x80FD;&#x591F;&#x52A8;&#x6001;&#x5730;&#x751F;&#x6210;HTML&#x6587;&#x6863;&#x65F6;&#xFF0C;&#x4F60;&#x4F1A;&#x89C9;&#x5F97;&#x66F4;&#x6709;&#x8DA3;&#x3002;</p>
<p><strong>&#x6CE8;&#x610F;&#xFF1A;</strong><code>@spec</code>&#x8FD9;&#x4E2A;&#x6CE8;&#x89E3;&#x4E00;&#x822C;&#x7528;&#x4E8E;&#x4EE3;&#x7801;&#x7684;&#x9759;&#x6001;&#x5206;&#x6790;&#x3002;&#x60F3;&#x4E86;&#x89E3;&#x66F4;&#x591A;&#x7684;&#x8BDD;&#xFF0C;&#x53EF;&#x4EE5;&#x770B;&#x4E0B;<a href="../../advanced/typespec">Specifications and types</a>&#x8FD9;&#x4E2A;&#x7AE0;&#x8282;&#x3002;</p>
<h2 id="exdoc">ExDoc</h2>
<p>ExDoc&#x662F;Elixir&#x7684;&#x5B98;&#x65B9;&#x9879;&#x76EE;&#xFF0C;&#x4F60;&#x53EF;&#x4EE5;&#x5728; <a href="https://github.com/elixir-lang/ex_doc" target="_blank">GitHub</a>&#x4E0A;&#x770B;&#x5230;&#x5B83;&#x3002;&#x5B83;&#x7528;&#x4E8E;&#x7ED9;Elixir&#x9879;&#x76EE;&#x63D0;&#x4F9B;<strong>&#x5728;&#x7EBF;HTML&#x6587;&#x6863;</strong>&#x3002;&#x9996;&#x5148;&#xFF0C;&#x5148;&#x8BA9;&#x6211;&#x4EEC;&#x7528;Mix&#x521B;&#x5EFA;&#x4E00;&#x4E2A;&#x65B0;&#x9879;&#x76EE;&#xFF1A;</p>
<pre><code class="lang-bash">$ mix new greet_everyone

* creating README.md
* creating .formatter.exs
* creating .gitignore
* creating mix.exs
* creating config
* creating config/config.exs
* creating lib
* creating lib/greet_everyone.ex
* creating <span class="hljs-built_in">test</span>
* creating <span class="hljs-built_in">test</span>/<span class="hljs-built_in">test</span>_helper.exs
* creating <span class="hljs-built_in">test</span>/greet_everyone_test.exs

Your Mix project was created successfully.
You can use <span class="hljs-string">&quot;mix&quot;</span> to compile it, <span class="hljs-built_in">test</span> it, and more:

    <span class="hljs-built_in">cd</span> greet_everyone
    mix <span class="hljs-built_in">test</span>

Run <span class="hljs-string">&quot;mix help&quot;</span> <span class="hljs-keyword">for</span> more commands.

$ <span class="hljs-built_in">cd</span> greet_everyone
</code></pre>
<p>&#x73B0;&#x5728;&#x5C06;<code>@doc</code>&#x7AE0;&#x8282;&#x7684;<code>lib/greeter.ex</code>&#x90E8;&#x5206;&#x7684;&#x4EE3;&#x7801;&#x590D;&#x5236;&#x7C98;&#x8D34;&#x8FC7;&#x6765;&#xFF0C;&#x5E76;&#x786E;&#x8BA4;&#x8FD9;&#x4E9B;&#x4EE3;&#x7801;&#x4F9D;&#x7136;&#x80FD;&#x6B63;&#x5E38;&#x8FD0;&#x884C;&#x3002;&#x65E2;&#x7136;&#x6211;&#x4EEC;&#x73B0;&#x5728;&#x8981;&#x64CD;&#x4F5C;&#x4E00;&#x4E2A;Mix&#x9879;&#x76EE;&#xFF0C;&#x90A3;&#x4E48;&#x6211;&#x4EEC;&#x9700;&#x8981;&#x4F7F;&#x7528;<code>iex -S mix</code>&#x6765;&#x5728;&#x7EC8;&#x7AEF;&#x4E2D;&#x6253;&#x5F00;&#x8FD9;&#x4E2A;&#x9879;&#x76EE;&#xFF1A;</p>
<pre><code class="lang-bash">iex&gt; h Greeter.hello

                def hello(name)

Prints a hello message

Parameters

  &#x2022; name: String that represents the name of the person.

Examples

    iex&gt; Greeter.hello(<span class="hljs-string">&quot;Sean&quot;</span>)
    <span class="hljs-string">&quot;Hello, Sean&quot;</span>

    iex&gt; Greeter.hello(<span class="hljs-string">&quot;pete&quot;</span>)
    <span class="hljs-string">&quot;Hello, pete&quot;</span>
</code></pre>
<h3 id="&#x5B89;&#x88C5;&#x8FC7;&#x7A0B;">&#x5B89;&#x88C5;&#x8FC7;&#x7A0B;</h3>
<p>&#x5047;&#x8BBE;&#x4E00;&#x5207;&#x90FD;&#x6B63;&#x5E38;&#x5DE5;&#x4F5C;&#xFF0C;&#x90A3;&#x4E48;&#x4F60;&#x5C06;&#x770B;&#x5230;&#x548C;&#x4E0A;&#x9762;&#x4E00;&#x6837;&#x7684;&#x8F93;&#x51FA;&#xFF0C;&#x73B0;&#x5728;&#x6211;&#x4EEC;&#x5C06;&#x914D;&#x7F6E;ExDoc&#x3002;&#x5728;&#x6587;&#x4EF6;<code>mix.exs</code>&#x4E2D;&#xFF0C;&#x6DFB;&#x52A0;&#x4E24;&#x4E2A;&#x4F9D;&#x8D56;<code>:earmark</code> &#x548C; <code>:ex_doc</code>&#x3002;</p>
<pre><code class="lang-elixir">  <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">deps</span></span> <span class="hljs-keyword">do</span>
    [{<span class="hljs-symbol">:earmark</span>, <span class="hljs-string">&quot;~&gt; 1.2&quot;</span>, <span class="hljs-symbol">only:</span> <span class="hljs-symbol">:dev</span>},
    {<span class="hljs-symbol">:ex_doc</span>, <span class="hljs-string">&quot;~&gt; 0.19&quot;</span>, <span class="hljs-symbol">only:</span> <span class="hljs-symbol">:dev</span>}]
  <span class="hljs-keyword">end</span>
</code></pre>
<p>&#x4F7F;&#x7528;<code>only: :dev</code>&#x662F;&#x56E0;&#x4E3A;&#x6211;&#x4EEC;&#x4E0D;&#x60F3;&#x5728;&#x751F;&#x4EA7;&#x73AF;&#x5883;&#x4E0B;&#x4E0B;&#x8F7D;&#x548C;&#x7F16;&#x8BD1;&#x8FD9;&#x4E9B;&#x4F9D;&#x8D56;&#x3002;&#x4E3A;&#x4EC0;&#x4E48;&#x9700;&#x8981;Earmark&#x5462;&#xFF1F;Earmark&#x662F;&#x4E00;&#x4E2A;&#x4F7F;&#x7528;Elixir&#x7F16;&#x5199;&#x7684;markdown&#x5206;&#x6790;&#x5668;&#xFF0C;ExDoc&#x4F7F;&#x7528;&#x5B83;&#x6765;&#x5C06;&#x5E26;&#x6709;<code>@moduledoc</code> &#x548C; <code>@doc</code>&#x7684;&#x6CE8;&#x91CA;&#x8F6C;&#x6362;&#x6210;&#x6F02;&#x4EAE;&#x7684;HTML&#x9875;&#x9762;&#x3002;</p>
<p>&#x4F60;&#x53EF;&#x4EE5;&#x4E0D;&#x4F7F;&#x7528;Earmark&#x3002;&#x4F60;&#x53EF;&#x4EE5;&#x5C06;&#x5206;&#x6790;&#x540E;&#x7AEF;&#x6539;&#x4E3A;Pandoc&#x3001;Hoedown&#x6216;&#x8005;Cmark&#xFF1B;&#x4F46;&#x662F;&#x4F60;&#x5F97;&#x6839;&#x636E;<a href="https://github.com/elixir-lang/ex_doc#changing-the-markdown-tool" target="_blank">&#x8FD9;&#x91CC;&#x7684;&#x6587;&#x6863;</a>&#x505A;&#x4E00;&#x70B9;&#x914D;&#x7F6E;&#x5DE5;&#x4F5C;&#x3002;&#x5728;&#x8FD9;&#x7BC7;&#x6559;&#x7A0B;&#x91CC;&#x9762;&#xFF0C;&#x6211;&#x4EEC;&#x5C06;&#x4F7F;&#x7528;Earmark&#x3002;</p>
<h3 id="&#x751F;&#x6210;&#x6587;&#x6863;">&#x751F;&#x6210;&#x6587;&#x6863;</h3>
<p>&#x7EE7;&#x7EED;&#x521A;&#x624D;&#x7684;&#x5DE5;&#x4F5C;&#xFF0C;&#x63A5;&#x4E0B;&#x6765;&#x9700;&#x8981;&#x8F93;&#x5165;&#x4E24;&#x6761;&#x547D;&#x4EE4;&#xFF1A;</p>
<pre><code class="lang-bash">$ mix deps.get <span class="hljs-comment"># gets ExDoc + Earmark.</span>
$ mix docs <span class="hljs-comment"># makes the documentation.</span>

Docs successfully generated.
View them at <span class="hljs-string">&quot;doc/index.html&quot;</span>.
</code></pre>
<p>&#x5982;&#x679C;&#x4E00;&#x5207;&#x987A;&#x5229;&#x7684;&#x8BDD;&#xFF0C;&#x4F60;&#x5C06;&#x4F1A;&#x770B;&#x5230;&#x719F;&#x6089;&#x7684;&#x6210;&#x529F;&#x63D0;&#x793A;&#x6D88;&#x606F;&#x3002;&#x8BA9;&#x6211;&#x4EEC;&#x770B;&#x4E00;&#x4E0B;&#x9879;&#x76EE;&#x91CC;&#x9762;&#x7684;<strong>doc/</strong>&#x6587;&#x4EF6;&#x5939;&#x3002;&#x91CC;&#x9762;&#x6709;&#x6211;&#x4EEC;&#x751F;&#x6210;&#x7684;&#x6587;&#x6863;&#x3002;&#x5982;&#x679C;&#x4F60;&#x4F7F;&#x7528;&#x6D4F;&#x89C8;&#x5668;&#x6253;&#x5F00;&#x5B83;&#x7684;&#x8BDD;&#x4F60;&#x5C06;&#x770B;&#x5230;&#x5982;&#x4E0B;&#x753B;&#x9762;&#xFF1A;</p>
<p><img src="../../images/documentation_1.png" alt="ExDoc Screenshot 1"></p>
<p>&#x6211;&#x4EEC;&#x53EF;&#x4EE5;&#x770B;&#x5230;Earmark&#x5DF2;&#x7ECF;&#x6E32;&#x67D3;&#x4E86;&#x6211;&#x4EEC;&#x7684;Markdown&#x6CE8;&#x91CA;&#x6587;&#x6863;&#x5E76;&#x4E14;ExDoc&#x73B0;&#x5728;&#x6709;&#x6F02;&#x4EAE;&#x7684;&#x663E;&#x793A;&#x683C;&#x5F0F;&#x3002;</p>
<p><img src="../../images/documentation_2.png" alt="ExDoc Screenshot 2"></p>
<p>&#x6211;&#x4EEC;&#x53EF;&#x4EE5;&#x5C06;&#x8FD9;&#x4E2A;&#x6587;&#x6863;&#x90E8;&#x7F72;&#x5230;github&#xFF0C;&#x4E5F;&#x53EF;&#x4EE5;&#x90E8;&#x7F72;&#x5230;Elixir&#x7684;&#x5B98;&#x65B9;&#x955C;&#x50CF; <a href="https://hexdocs.pm/" target="_blank">HexDocs</a>&#x3002;</p>
<h2 id="&#x6700;&#x4F73;&#x5B9E;&#x8DF5;">&#x6700;&#x4F73;&#x5B9E;&#x8DF5;</h2>
<p>&#x7F16;&#x5199;&#x6587;&#x6863;&#x662F;&#x7F16;&#x7A0B;&#x7684;&#x6700;&#x4F73;&#x5B9E;&#x8DF5;&#x3002;&#x56E0;&#x4E3A;Elixir&#x8FD8;&#x5F88;&#x5E74;&#x8F7B;&#xFF0C;&#x8BB8;&#x591A;&#x8BED;&#x8A00;&#x6807;&#x51C6;&#x4F9D;&#x7136;&#x5728;&#x968F;&#x7740;&#x5B83;&#x7684;&#x751F;&#x6001;&#x53D1;&#x5C55;&#x800C;&#x53D1;&#x5C55;&#x3002;Elixir&#x7684;&#x793E;&#x533A;&#x6B63;&#x5728;&#x5C1D;&#x8BD5;&#x8FDB;&#x884C;&#x8FD9;&#x79CD;&#x6700;&#x4F73;&#x5B9E;&#x8DF5;&#x3002;&#x4F60;&#x53EF;&#x4EE5;&#x4ECE;<a href="https://github.com/niftyn8/elixir_style_guide" target="_blank">Elixir&#x4EE3;&#x7801;&#x98CE;&#x683C;</a>&#x4E2D;&#x4E86;&#x89E3;&#x5230;&#x7C7B;&#x4F3C;&#x7684;&#x6700;&#x4F73;&#x5B9E;&#x8DF5;&#x3002;</p>
<ul>
<li>&#x603B;&#x662F;&#x7ED9;&#x6A21;&#x5757;&#x63D0;&#x4F9B;&#x6CE8;&#x91CA;</li>
</ul>
<pre><code class="lang-elixir"><span class="hljs-class"><span class="hljs-keyword">defmodule</span> <span class="hljs-title">Greeter</span></span> <span class="hljs-keyword">do</span>
  <span class="hljs-variable">@moduledoc</span> <span class="hljs-string">&quot;&quot;</span><span class="hljs-string">&quot;
  This is good documentation.
  &quot;</span><span class="hljs-string">&quot;&quot;</span>

<span class="hljs-keyword">end</span>
</code></pre>
<ul>
<li>&#x5982;&#x679C;&#x4F60;&#x4E0D;&#x60F3;&#x7ED9;&#x6A21;&#x5757;&#x6CE8;&#x91CA;&#xFF0C;<strong>&#x4E0D;&#x8981;&#x7559;&#x7A7A;</strong>&#x3002;&#x53EF;&#x4EE5;&#x8003;&#x8651;&#x7ED9;&#x6A21;&#x5757;&#x6CE8;&#x89E3;&#x63D0;&#x4F9B;&#x4E00;&#x4E2A;&#x503C;&#x4E3A;<code>false</code>&#x7684;&#x53C2;&#x6570;&#xFF0C;&#x5C31;&#x50CF;&#x4E0B;&#x9762;&#x8FD9;&#x6837;&#xFF1A;</li>
</ul>
<pre><code class="lang-elixir"><span class="hljs-class"><span class="hljs-keyword">defmodule</span> <span class="hljs-title">Greeter</span></span> <span class="hljs-keyword">do</span>
  <span class="hljs-variable">@moduledoc</span> <span class="hljs-keyword">false</span>

<span class="hljs-keyword">end</span>
</code></pre>
<ul>
<li>&#x5F53;&#x5728;&#x6A21;&#x5757;&#x91CC;&#x9762;&#x5F15;&#x7528;&#x4E00;&#x4E2A;&#x51FD;&#x6570;&#x65F6;&#xFF0C;&#x4F7F;&#x7528;&#x5355;&#x5F15;&#x53F7;&#x5C06;&#x5176;&#x62EC;&#x8D77;&#x6765;&#xFF1A;</li>
</ul>
<pre><code class="lang-elixir"><span class="hljs-class"><span class="hljs-keyword">defmodule</span> <span class="hljs-title">Greeter</span></span> <span class="hljs-keyword">do</span>
  <span class="hljs-variable">@moduledoc</span> <span class="hljs-string">&quot;&quot;</span><span class="hljs-string">&quot;
  ...

  This module also has a `hello/1` function.
  &quot;</span><span class="hljs-string">&quot;&quot;</span>

  <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">hello</span></span>(name) <span class="hljs-keyword">do</span>
    IO.puts(<span class="hljs-string">&quot;Hello, &quot;</span> &lt;&gt; name)
  <span class="hljs-keyword">end</span>
<span class="hljs-keyword">end</span>
</code></pre>
<ul>
<li><code>@moduledoc</code>&#x4E0B;&#x9762;&#x7684;&#x4EE3;&#x7801;&#x4E00;&#x884C;&#x53EA;&#x5199;&#x4E00;&#x53E5;&#xFF1A;</li>
</ul>
<pre><code class="lang-elixir"><span class="hljs-class"><span class="hljs-keyword">defmodule</span> <span class="hljs-title">Greeter</span></span> <span class="hljs-keyword">do</span>
  <span class="hljs-variable">@moduledoc</span> <span class="hljs-string">&quot;&quot;</span><span class="hljs-string">&quot;
  ...

  This module also has a `hello/1` function.
  &quot;</span><span class="hljs-string">&quot;&quot;</span>

  <span class="hljs-keyword">alias</span> Goodbye.bye_bye
  <span class="hljs-comment"># &#x5C31;&#x50CF;&#x4E0A;&#x9762;&#x8FD9;&#x6837;...</span>

  <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">hello</span></span>(name) <span class="hljs-keyword">do</span>
    IO.puts(<span class="hljs-string">&quot;Hello, &quot;</span> &lt;&gt; name)
  <span class="hljs-keyword">end</span>
<span class="hljs-keyword">end</span>
</code></pre>
<ul>
<li>&#x4F7F;&#x7528;markdown&#x8BED;&#x6CD5;&#x6765;&#x7F16;&#x5199;&#x6587;&#x6863;&#x3002;&#x56E0;&#x4E3A;&#x5B83;&#x80FD;&#x88AB;ExDoc&#x548C;IEx&#x66F4;&#x597D;&#x5730;&#x89E3;&#x6790;&#xFF1A;</li>
</ul>
<pre><code class="lang-elixir"><span class="hljs-class"><span class="hljs-keyword">defmodule</span> <span class="hljs-title">Greeter</span></span> <span class="hljs-keyword">do</span>
  <span class="hljs-variable">@moduledoc</span> <span class="hljs-string">&quot;&quot;</span><span class="hljs-string">&quot;
  ...
  &quot;</span><span class="hljs-string">&quot;&quot;</span>

  <span class="hljs-variable">@doc</span> <span class="hljs-string">&quot;&quot;</span><span class="hljs-string">&quot;
  Prints a hello message

  ## Parameters

    - name: String that represents the name of the person.

  ## Examples

      iex&gt; Greeter.hello(&quot;</span>Sean<span class="hljs-string">&quot;)
      &quot;</span>Hello, Sean<span class="hljs-string">&quot;

      iex&gt; Greeter.hello(&quot;</span>pete<span class="hljs-string">&quot;)
      &quot;</span>Hello, pete<span class="hljs-string">&quot;

  &quot;</span><span class="hljs-string">&quot;&quot;</span>
  <span class="hljs-variable">@spec</span> hello(String.t()) <span class="hljs-symbol">:</span><span class="hljs-symbol">:</span> String.t()
  <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">hello</span></span>(name) <span class="hljs-keyword">do</span>
    <span class="hljs-string">&quot;Hello, &quot;</span> &lt;&gt; name
  <span class="hljs-keyword">end</span>
<span class="hljs-keyword">end</span>
</code></pre>
<ul>
<li>&#x5C1D;&#x8BD5;&#x5728;&#x4F60;&#x7684;&#x6587;&#x6863;&#x91CC;&#x9762;&#x52A0;&#x5165;&#x4E00;&#x4E9B;&#x6D4B;&#x8BD5;&#x4EE3;&#x7801;&#x3002; &#x8FD9;&#x5C06;&#x80FD;&#x591F;&#x8BA9;&#x4F60;&#x5728;&#x6A21;&#x5757; <a href="https://hexdocs.pm/ex_unit/ExUnit.DocTest.html" target="_blank">ExUnit.DocTest</a>&#x7684;&#x5E2E;&#x52A9;&#x4E0B;&#x5BF9;&#x6A21;&#x5757;&#x3001;&#x51FD;&#x6570;&#x3001;&#x5B8F;&#x7B49;&#x751F;&#x6210;&#x81EA;&#x52A8;&#x6D4B;&#x8BD5;&#x3002;&#x4E3A;&#x4E86;&#x505A;&#x5230;&#x8FD9;&#x4E00;&#x70B9;&#xFF0C;&#x4F60;&#x9700;&#x8981;&#x5728;&#x4F60;&#x7684;&#x6D4B;&#x8BD5;&#x7528;&#x4F8B;&#x4E2D;&#x4F7F;&#x7528;<code>doctest/1</code>&#x8FD9;&#x4E2A;&#x5B8F;&#x3002;&#x5F53;&#x7136;&#xFF0C;&#x4F60;&#x9996;&#x5148;&#x5F97;&#x770B;&#x4E00;&#x4E0B;<a href="https://hexdocs.pm/ex_unit/ExUnit.DocTest.html" target="_blank">ExUnit&#x7684;&#x5B98;&#x65B9;&#x6587;&#x6863;</a>&#x3002;</li>
</ul>

                                
                                </section>
                            
    </div>
    <div class="search-results">
        <div class="has-results">
            
            <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
            <ul class="search-results-list"></ul>
            
        </div>
        <div class="no-results">
            
            <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
            
        </div>
    </div>
</div>

                        </div>
                    </div>
                
            </div>

            
                
                <a href="sigils.html" class="navigation navigation-prev " aria-label="Previous page: 魔符(Sigil)">
                    <i class="fa fa-angle-left"></i>
                </a>
                
                
                <a href="testing.html" class="navigation navigation-next " aria-label="Next page: 测试">
                    <i class="fa fa-angle-right"></i>
                </a>
                
            
        
    </div>

    <script>
        var gitbook = gitbook || [];
        gitbook.push(function() {
            gitbook.page.hasChanged({"page":{"version":"1.0.3","title":"文档模块","level":"1.12","depth":1,"next":{"title":"测试","level":"1.13","depth":1,"path":"lessons/basics/testing.md","ref":"lessons/basics/testing.md","articles":[]},"previous":{"title":"魔符(Sigil)","level":"1.11","depth":1,"path":"lessons/basics/sigils.md","ref":"lessons/basics/sigils.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"lessons/basics/documentation.md","mtime":"2019-11-05T02:25:51.000Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-11-05T03:01:22.004Z"},"basePath":"../..","book":{"language":""}});
        });
    </script>
</div>

        
    <script src="../../gitbook/gitbook.js"></script>
    <script src="../../gitbook/theme.js"></script>
    
        
        <script src="../../gitbook/gitbook-plugin-search/search-engine.js"></script>
        
    
        
        <script src="../../gitbook/gitbook-plugin-search/search.js"></script>
        
    
        
        <script src="../../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
        
    
        
        <script src="../../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
        
    
        
        <script src="../../gitbook/gitbook-plugin-sharing/buttons.js"></script>
        
    
        
        <script src="../../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
        
    

    </body>
</html>

